GET api/account/holdings?clientID={clientID}&adviserID={adviserID}&licenseeID={licenseeID}&personID={personID}&codes[0]={codes[0]}&codes[1]={codes[1]}&includeHistoricalHoldings={includeHistoricalHoldings}

Get portfolio holdings.

Request Information

URI Parameters

Name	Description	Type	Additional information
clientID	Client ID to filter on.	integer	None.
adviserID	Adviser ID to filter on.	integer	None.
licenseeID	Licensee ID to filter on.	integer	None.
personID	Person ID to filter on.	integer	None.
codes	Security codes to filter on.	Collection of string	None.
includeHistoricalHoldings	include historical holdings to filter on.	boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

Portfolio holdings grouped by client account.

Collection of ClientHoldingBalance

Name	Description	Type	Additional information
ClientID	Unique client identifier.	integer	None.
HoldingBalances	Holding balances	Collection of HoldingBalance	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ClientID": 1234,
    "HoldingBalances": [
      {
        "SecurityCode": "BHP",
        "SecurityName": "BHP GROUP LIMITED ORDINARY",
        "HoldingQuantity": 1500.0,
        "AvailableQuantity": 1000.0,
        "AverageCostBase": 20.0,
        "Timestamp": "2024-09-29T14:49:38.5659608+10:00",
        "EntryPrice": 78.0
      },
      {
        "SecurityCode": "CBA",
        "SecurityName": "COMMONWEALTH BANK. ORDINARY",
        "HoldingQuantity": 2000.0,
        "AvailableQuantity": 2000.0,
        "AverageCostBase": 80.0,
        "Timestamp": "2024-09-29T14:49:38.5659608+10:00",
        "EntryPrice": 52.0
      }
    ]
  },
  {
    "ClientID": 6789,
    "HoldingBalances": [
      {
        "SecurityCode": "BHP",
        "SecurityName": "BHP GROUP LIMITED ORDINARY",
        "HoldingQuantity": 1500.0,
        "AvailableQuantity": 1000.0,
        "AverageCostBase": 20.0,
        "Timestamp": "2024-09-29T14:49:38.5659608+10:00",
        "EntryPrice": 78.0
      },
      {
        "SecurityCode": "CBA",
        "SecurityName": "COMMONWEALTH BANK. ORDINARY",
        "HoldingQuantity": 2000.0,
        "AvailableQuantity": 2000.0,
        "AverageCostBase": 80.0,
        "Timestamp": "2024-09-29T14:49:38.5659608+10:00",
        "EntryPrice": 52.0
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfClientHoldingBalance xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.Contracts.Services.Portfolio">
  <ClientHoldingBalance>
    <ClientID>1234</ClientID>
    <HoldingBalances>
      <HoldingBalance>
        <AvailableQuantity>1000</AvailableQuantity>
        <AverageCostBase>20.00</AverageCostBase>
        <EntryPrice>78.00</EntryPrice>
        <HoldingQuantity>1500</HoldingQuantity>
        <SecurityCode>BHP</SecurityCode>
        <SecurityName>BHP GROUP LIMITED ORDINARY</SecurityName>
        <Timestamp>2024-09-29T14:49:38.5659608+10:00</Timestamp>
      </HoldingBalance>
      <HoldingBalance>
        <AvailableQuantity>2000</AvailableQuantity>
        <AverageCostBase>80.00</AverageCostBase>
        <EntryPrice>52.00</EntryPrice>
        <HoldingQuantity>2000</HoldingQuantity>
        <SecurityCode>CBA</SecurityCode>
        <SecurityName>COMMONWEALTH BANK. ORDINARY</SecurityName>
        <Timestamp>2024-09-29T14:49:38.5659608+10:00</Timestamp>
      </HoldingBalance>
    </HoldingBalances>
  </ClientHoldingBalance>
  <ClientHoldingBalance>
    <ClientID>6789</ClientID>
    <HoldingBalances>
      <HoldingBalance>
        <AvailableQuantity>1000</AvailableQuantity>
        <AverageCostBase>20.00</AverageCostBase>
        <EntryPrice>78.00</EntryPrice>
        <HoldingQuantity>1500</HoldingQuantity>
        <SecurityCode>BHP</SecurityCode>
        <SecurityName>BHP GROUP LIMITED ORDINARY</SecurityName>
        <Timestamp>2024-09-29T14:49:38.5659608+10:00</Timestamp>
      </HoldingBalance>
      <HoldingBalance>
        <AvailableQuantity>2000</AvailableQuantity>
        <AverageCostBase>80.00</AverageCostBase>
        <EntryPrice>52.00</EntryPrice>
        <HoldingQuantity>2000</HoldingQuantity>
        <SecurityCode>CBA</SecurityCode>
        <SecurityName>COMMONWEALTH BANK. ORDINARY</SecurityName>
        <Timestamp>2024-09-29T14:49:38.5659608+10:00</Timestamp>
      </HoldingBalance>
    </HoldingBalances>
  </ClientHoldingBalance>
</ArrayOfClientHoldingBalance>

Error Response Information

Resource Description

Portfolio holdings grouped by client account.

string

Error Response Formats

application/json, text/json

Sample:

"sample string 1"

application/xml, text/xml

Sample:

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>